<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <title>Grape::API</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" />
<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>

</head>

<body>
    <div class="banner">
        
        <h1>
            <span class="type">Class</span>
            Grape::API
            
                <span class="parent">&lt;
                    
                    Object
                    
                </span>
            
        </h1>
        <ul class="files">
            
            <li><a href="../../files/app/api/grape/api_rb.html">app/api/grape/api.rb</a></li>
            
        </ul>
    </div>
    <div id="bodyContent">
        <div id="content">
  


  


  
  


  


  
    <!-- Method ref -->
    <div class="sectiontitle">Methods</div>
    <dl class="methods">
      
        <dt>A</dt>
        <dd>
          <ul>
            
              
              <li>
                <a href="#method-c-add_desc">add_desc</a>
              </li>
            
          </ul>
        </dd>
      
    </dl>
  

  



  

    

    

    


    


    <!-- Methods -->
    
      <div class="sectiontitle">Class Public methods</div>
      
        <div class="method">
          <div class="title method-title" id="method-c-add_desc">
            
              <b>add_desc</b>(desc, options={})
            
            <a href="../../classes/Grape/API.html#method-c-add_desc" name="method-c-add_desc" class="permalink">Link</a>
          </div>

          
            <div class="description">
              <p>文档中需要填写header信息时使用</p>
            </div>
          

          

          

          
            
            <div class="sourcecode">
              
              <p class="source-link">
                Source:
                <a href="javascript:toggleSource('method-c-add_desc_source')" id="l_method-c-add_desc_source">show</a>
                
              </p>
              <div id="method-c-add_desc_source" class="dyn-source">
                <pre><span class="ruby-comment"># File app/api/grape/api.rb, line 5</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">add_desc</span>(<span class="ruby-identifier">desc</span>, <span class="ruby-identifier">options</span>={})
  <span class="ruby-identifier">desc</span> <span class="ruby-node">&quot;#{desc}&quot;</span>, {
    <span class="ruby-identifier">headers</span><span class="ruby-operator">:</span> {
      <span class="ruby-string">&quot;Authorization&quot;</span> =<span class="ruby-operator">&gt;</span> {
        <span class="ruby-identifier">description</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;用户token&quot;</span>,
        <span class="ruby-identifier">required</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
      },
      <span class="ruby-string">&quot;Http-Username&quot;</span> =<span class="ruby-operator">&gt;</span> {
        <span class="ruby-identifier">description</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;用户名称&quot;</span>,
        <span class="ruby-identifier">required</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
      },
      <span class="ruby-string">&quot;X-Client-Key&quot;</span> =<span class="ruby-operator">&gt;</span> {
        <span class="ruby-identifier">description</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;访问权限&quot;</span>,
        <span class="ruby-identifier">required</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
      }
    }
  }.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span></pre>
              </div>
            </div>
            
          </div>
                        </div>

    </div>
  </body>
</html>
